home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 1 / Amiga Tools.iso / findfile.doc < prev    next >
Text File  |  1994-06-06  |  5KB  |  143 lines
  1. ******************************************************************************
  2. *                  FindFile                     *
  3. *              an AmigaDOS 2.04 Commodity                 *
  4. *                                         *
  5. *          Code Developed & Written By: Russ Steffen             *
  6. ******************************************************************************
  7.  
  8. I. Introduction
  9.  
  10.    FindFile is an AmigaDOS 2.04 Commodity modeled after the "Find File"
  11.    Desk Accessory on the Macintosh. It will search any AmigaDOS volume for
  12.    all files that match a given pattern.
  13.  
  14.  
  15.    FindFile requires only AmigaDOS 2.04 (V37), and will not work under under
  16.    earlier AmigaDOS 2.0 releases, such as 2.02.
  17.  
  18.  
  19. II. Supported ToolTypes
  20.  
  21.   As a commodity, FindFile supports all aplicable standard ToolTypes, plus
  22.   some custom ToolTypes.
  23.  
  24.  
  25.     CX_POPUP          If YES, FindFile's window will open
  26.               at startup.
  27.               Default: NO
  28.  
  29.  
  30.     CX_PRIORITY       Sets FindFile's commodity priority.
  31.               Default: 0
  32.  
  33.     CX_POPKEY          Sets FindFile's hot key. Pressing this key
  34.               will either open the window, or bring it to
  35.               the front.
  36.               Default: "LCommand help"
  37.  
  38.     DEF_PATTERN       Sets FindFile's default search pattern.
  39.               Default: #? (Matches all files)
  40.  
  41.  
  42.     CENTERWINDOW      Controls FindFile's window behavior when it
  43.               is opened.
  44.                 YES causes the window to be centered on the mouse
  45.                 every time it is opened.
  46.                 NO    causes the window to be mouse centered only on
  47.                 the first opening. After that, the window will
  48.                 remember it's position when it closes, and will
  49.                 reopen at that position.
  50.               Default: YES
  51.  
  52.  
  53.     IGNOREICONS       If YES, FindFile will skip all .info files it encounters.
  54.               Default: NO
  55.  
  56.  
  57.     SORTLIST          If YES, the list of files that FindFile finds will
  58.               be sorted alphabetically.
  59.  
  60.     INTITIAL_DIR      The initial directory to search. Warning: it may be possible
  61.               to confuse FindFile by giving it a non-existant directory.
  62.  
  63.  
  64.     Please note: All tooltypes may be given as either true ToolTypes in FindFile's
  65.          icon, or as command line parameters. If given as CLI parameters,
  66.          ToolTypes with spaces in them should be enclosed in quotes.
  67.          ( e.g. "DEF_PATTERN=#? #?" matches any files with a space in the
  68.            name. )
  69.  
  70.  
  71. III. Window Operation
  72.  
  73.   The FindFile Window contains the following gadgets:
  74.  
  75.   Search Pattern:  A string gadget where the AmigaDOS pattern to search is entered.
  76.            The default value is controlled by the DEF_PATTERN ToolType.
  77.            Keyboard Eqiv: P
  78.  
  79.  
  80.   Device to Search:  A string gadget that specifies the directory to start searching.
  81.              Warning: It may be possible to confuse FindFile by giving it
  82.              a non-existant directory.
  83.              Keyboard Eqiv: D
  84.  
  85.   Directory req: Brings up the ASL file requester to select the search directory.
  86.          Looks like a button with a '?' in it.
  87.          Keyboard Eqiv: ?
  88.  
  89.   Files Found: A ListView gadget that will contain a list of files found during and
  90.            after the actual search, and their complete path.
  91.            Keyboard Eqiv: F
  92.  
  93.   Search: This button will initiate a search. The search may be aborted by
  94.       the Quit button, described later on.
  95.       Keyboard Eqiv: S
  96.  
  97.   Hide: This button will cause FindFile to hide it's window. The window can be
  98.     reopened by pressing the program's hot key, wich defaults to Left-Command HELP.
  99.     Keyboard Eqiv: H
  100.  
  101.   Quit: This is a dual purpose button. When FindFile is searching for files, this
  102.     button will abort the search. Otherwise, this will terminate the program.
  103.  
  104. IV. COPYRIGHT & DISCLAIMER
  105.  
  106.   This program is copyrighted by the author. Permission is granted for private use.
  107.   This program is also freely redistributable, and encouraged, provided that the
  108.   following criteria are met. 1) The complete program package must remain intact. The
  109.   complete program package consists of (A) The binary executable {FindFile} (B) The
  110.   C-Language source code {FindFile.c & .h, FFASLReq.c, FFSearch.c, FFWindow.c CX.c}
  111.   (C) This documentation file {FindFile.doc} (D) Any icon { .info } files.
  112.   (E) Any Addendums or README type files than may become necessary in future revisions.
  113.  
  114.   This program is distributed in the hope that it will be useful, but WITHOUT
  115.   ANY WARRANTY; without even the IMPLIED warranty of MERCHANTIBILTY or FITNESS
  116.   FOR A PARTICULAR PURPOSE.
  117.  
  118.   The author may not be held responsible by any damage caused by the use or misuse
  119.   of this program. This program is distributed as-is, and can not be guaranteed to
  120.   work under all conditions & circumstances. Use this program at your own risk.
  121.  
  122. V. Author's Information
  123.  
  124.   Name:        Russell R. Steffen
  125.   Home Address:    11551 Sherman Rd.
  126.            Cedarburg, WI 53012       (Permanent)
  127.  
  128.   School Address:  318 Callahan Hall
  129.            Menomonie, WI 54751        (Valid until May, 1993)
  130.  
  131.   Email:       STEFFENR@UWSTOUT.EDU
  132.  
  133. VI. CREDITS
  134.  
  135.   Thanks to the authors of the Amiga Techincal Reference Series at Commodore. Thanks
  136.   also to the author of FracBlank, Olaf 'Olsen' Barthel, who's code showed me how
  137.   to center a window on the mouse pointer.
  138.  
  139.   Also, thanks to the members of the Dead Moose Society ( Erik, Emmy, Dick,
  140.   Shawn, Sara, Spike & Max ), whose many diversions kept my sanity in check this
  141.   summer. ( Beware of lurking rangers, guys! )
  142.  
  143.